<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>EOS.IO: Transaction C API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="eos-logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">EOS.IO
   &#160;<span id="projectnumber">DAWN1.1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Transaction C API<div class="ingroups"><a class="el" href="group__contractdev.html">How To Write Contracts</a> &raquo; <a class="el" href="group__transactionapi.html">Transaction API</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Define API for sending transactions.  
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Transaction C API:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__transactioncapi.png" border="0" alt="" usemap="#group____transactioncapi"/>
<map name="group____transactioncapi" id="group____transactioncapi">
<area shape="rect" id="node2" href="group__transactionapi.html" title="Define API for sending transactions and inline messages. " alt="" coords="5,5,121,32"/>
</map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga58df052e13ad2a3d54a2b1c99a2a8925"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga58df052e13ad2a3d54a2b1c99a2a8925">InvalidTransactionHandle</a>&#160;&#160;&#160;(0xFFFFFFFFUL)</td></tr>
<tr class="separator:ga58df052e13ad2a3d54a2b1c99a2a8925"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b337c3f5a641ee82e84d209a8bba0d7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga4b337c3f5a641ee82e84d209a8bba0d7">InvalidMessageHandle</a>&#160;&#160;&#160;(0xFFFFFFFFUL)</td></tr>
<tr class="separator:ga4b337c3f5a641ee82e84d209a8bba0d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga7a095ea0165891d5ee1dbd8ee40e32cb"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a></td></tr>
<tr class="separator:ga7a095ea0165891d5ee1dbd8ee40e32cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa42fca851fc0bcfd9dffc229c9552ce5"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a></td></tr>
<tr class="separator:gaa42fca851fc0bcfd9dffc229c9552ce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga180dc33e735f9631ed9a800d7b0a511e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga180dc33e735f9631ed9a800d7b0a511e">transactionCreate</a> ()</td></tr>
<tr class="memdesc:ga180dc33e735f9631ed9a800d7b0a511e"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a pending transaction  <a href="#ga180dc33e735f9631ed9a800d7b0a511e">More...</a><br /></td></tr>
<tr class="separator:ga180dc33e735f9631ed9a800d7b0a511e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga347cc9c284bc25ed1d67b596e2320cdc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga347cc9c284bc25ed1d67b596e2320cdc">transactionRequireScope</a> (<a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a> trx, <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> scope, int readOnly=0)</td></tr>
<tr class="memdesc:ga347cc9c284bc25ed1d67b596e2320cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">require a scope to process a pending transaction  <a href="#ga347cc9c284bc25ed1d67b596e2320cdc">More...</a><br /></td></tr>
<tr class="separator:ga347cc9c284bc25ed1d67b596e2320cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1290a226d7828410020ed2954ffa5fa5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga1290a226d7828410020ed2954ffa5fa5">transactionAddMessage</a> (<a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a> trx, <a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a> msg)</td></tr>
<tr class="memdesc:ga1290a226d7828410020ed2954ffa5fa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">finalize the pending message and add it to the transaction  <a href="#ga1290a226d7828410020ed2954ffa5fa5">More...</a><br /></td></tr>
<tr class="separator:ga1290a226d7828410020ed2954ffa5fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga01eab43648b29422885d4d59a2864aaf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga01eab43648b29422885d4d59a2864aaf">transactionSend</a> (<a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a> trx)</td></tr>
<tr class="memdesc:ga01eab43648b29422885d4d59a2864aaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">send a pending transaction  <a href="#ga01eab43648b29422885d4d59a2864aaf">More...</a><br /></td></tr>
<tr class="separator:ga01eab43648b29422885d4d59a2864aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37162c1f843ae69d0134be29b1cde61f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga37162c1f843ae69d0134be29b1cde61f">transactionDrop</a> (<a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a> trx)</td></tr>
<tr class="memdesc:ga37162c1f843ae69d0134be29b1cde61f"><td class="mdescLeft">&#160;</td><td class="mdescRight">drop a pending transaction  <a href="#ga37162c1f843ae69d0134be29b1cde61f">More...</a><br /></td></tr>
<tr class="separator:ga37162c1f843ae69d0134be29b1cde61f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6940a3e31486bef36409f857e0ed7c72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga6940a3e31486bef36409f857e0ed7c72">messageCreate</a> (<a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> code, <a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a> type, void const *data, int size)</td></tr>
<tr class="memdesc:ga6940a3e31486bef36409f857e0ed7c72"><td class="mdescLeft">&#160;</td><td class="mdescRight">create a pending message  <a href="#ga6940a3e31486bef36409f857e0ed7c72">More...</a><br /></td></tr>
<tr class="separator:ga6940a3e31486bef36409f857e0ed7c72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabf3f53f695c30abe4bd48f9b3341a016"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#gabf3f53f695c30abe4bd48f9b3341a016">messageRequirePermission</a> (<a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a> msg, <a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a> account, <a class="el" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a> permission)</td></tr>
<tr class="memdesc:gabf3f53f695c30abe4bd48f9b3341a016"><td class="mdescLeft">&#160;</td><td class="mdescRight">require a permission for the pending message  <a href="#gabf3f53f695c30abe4bd48f9b3341a016">More...</a><br /></td></tr>
<tr class="separator:gabf3f53f695c30abe4bd48f9b3341a016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1f9346e3ef3fae10cf5fee5b9a0270ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga1f9346e3ef3fae10cf5fee5b9a0270ca">messageSend</a> (<a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a> msg)</td></tr>
<tr class="memdesc:ga1f9346e3ef3fae10cf5fee5b9a0270ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">send a pending message as an inline message  <a href="#ga1f9346e3ef3fae10cf5fee5b9a0270ca">More...</a><br /></td></tr>
<tr class="separator:ga1f9346e3ef3fae10cf5fee5b9a0270ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga77f1412808c199633b41bf2f20e3cb45"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__transactioncapi.html#ga77f1412808c199633b41bf2f20e3cb45">messageDrop</a> (<a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a> msg)</td></tr>
<tr class="memdesc:ga77f1412808c199633b41bf2f20e3cb45"><td class="mdescLeft">&#160;</td><td class="mdescRight">discard a pending message  <a href="#ga77f1412808c199633b41bf2f20e3cb45">More...</a><br /></td></tr>
<tr class="separator:ga77f1412808c199633b41bf2f20e3cb45"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga4b337c3f5a641ee82e84d209a8bba0d7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define InvalidMessageHandle&#160;&#160;&#160;(0xFFFFFFFFUL)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga58df052e13ad2a3d54a2b1c99a2a8925"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define InvalidTransactionHandle&#160;&#160;&#160;(0xFFFFFFFFUL)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="gaa42fca851fc0bcfd9dffc229c9552ce5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ga7a095ea0165891d5ee1dbd8ee40e32cb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="group__types.html#ga06896e8c53f721507066c079052171f8">uint32_t</a> <a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga6940a3e31486bef36409f857e0ed7c72"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a> messageCreate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga4c11ea58b1daa61a364225a757a05cd2">FuncName</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void const *&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function creates a pending message to be included in a deferred transaction or to be send as an inline message</p>
<p>This message has no default permissions, see <a class="el" href="group__transactioncapi.html#gabf3f53f695c30abe4bd48f9b3341a016">messageRequirePermission</a></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">code</td><td>- the <code>AccountName</code> which owns the contract code to execute </td></tr>
    <tr><td class="paramname">type</td><td>- the type of this message </td></tr>
    <tr><td class="paramname">data</td><td>- the payload data for this message </td></tr>
    <tr><td class="paramname">size</td><td>- the size of <code>data</code> </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga77f1412808c199633b41bf2f20e3cb45"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void messageDrop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a>&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This handle should be considered invalid after the call</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trx</td><td>- the <code>MessageHandle</code> of the pending message to discard </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gabf3f53f695c30abe4bd48f9b3341a016"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void messageRequirePermission </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a>&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
          <td class="paramname"><em>account</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#ga4bd93be9c597a8d7b6a1a3504ca63e83">PermissionName</a>&#160;</td>
          <td class="paramname"><em>permission</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Indicates that a given pending message requires a certain permission</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>- the <code>MessageHandle</code> pending message referred to </td></tr>
    <tr><td class="paramname">account</td><td>- the <code>AccountName</code> to of the permission </td></tr>
    <tr><td class="paramname">permission</td><td>- the <code>PermissionName</code> to of the permision </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga1f9346e3ef3fae10cf5fee5b9a0270ca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void messageSend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a>&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This handle should be considered invalid after the call</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>- the <code>MessageHandle</code> of the pending message to send inline </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga1290a226d7828410020ed2954ffa5fa5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void transactionAddMessage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a>&#160;</td>
          <td class="paramname"><em>trx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#gaa42fca851fc0bcfd9dffc229c9552ce5">MessageHandle</a>&#160;</td>
          <td class="paramname"><em>msg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The message handle should be considered invalid after the call</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trx</td><td>- the <code>TransactionHandle</code> of the pending transaction to modify </td></tr>
    <tr><td class="paramname">msg</td><td>- the <code>MessageHandle</code> of the pending message to add </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga180dc33e735f9631ed9a800d7b0a511e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a> transactionCreate </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function allocates a native transaction and returns a handle to the caller. Within the context of a single transaction there is a soft limit to the number of pending transactions that can be open at a time. This limit is at the descretion of the <a class="el" href="struct_producers.html">Producers</a> and exceding it will result in the current transaction context failing.</p>
<dl class="section return"><dt>Returns</dt><dd>handle used to refer to this transaction in future API calls </dd></dl>

</div>
</div>
<a class="anchor" id="ga37162c1f843ae69d0134be29b1cde61f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void transactionDrop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a>&#160;</td>
          <td class="paramname"><em>trx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function will discard a pending transaction and its associated resources. Once a transaction is sent it can no longer be dropped.</p>
<p>This handle should be considered invalid after the call</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trx</td><td>- the <code>TransactionHandle</code> of the pending transaction to send </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga347cc9c284bc25ed1d67b596e2320cdc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void transactionRequireScope </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a>&#160;</td>
          <td class="paramname"><em>trx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__types.html#gad67b43dc23285b01176f4c181c59fc23">AccountName</a>&#160;</td>
          <td class="paramname"><em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>readOnly</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function adds either a <code>scope</code> or <code>readScope</code> to the given pending transaction.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trx</td><td>- the <code>TransactionHandle</code> of the pending transaction to modify </td></tr>
    <tr><td class="paramname">scope</td><td>- the <code>AccountName</code> to add </td></tr>
    <tr><td class="paramname">readOnly</td><td>- whether <code>scope</code> should be added to <code>scope[]</code> or <code>readScope[]</code> </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ga01eab43648b29422885d4d59a2864aaf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void transactionSend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__transactioncapi.html#ga7a095ea0165891d5ee1dbd8ee40e32cb">TransactionHandle</a>&#160;</td>
          <td class="paramname"><em>trx</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function will finalize a pending transaction and enqueue it for processing either immediately after this transaction and its previously sent inline transactions complete OR in a future block.</p>
<p>This handle should be considered invalid after the call</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">trx</td><td>- the <code>TransactionHandle</code> of the pending transaction to send </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
